<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->

<html>
<head>
    <link rel="stylesheet" type="text/css" href="../../docs/css/style.css"/>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <title>JMeter - User's Manual: Building a Monitor Test Plan</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" cellspacing="0">
    <tr>
        <td colspan="2">
            <a href="http://jakarta.apache.org"><img width="505" height="48" src="../../docs/images/jakarta-logo.gif"
                                                     align="left" border="0"></a>
        </td>
    </tr>
</table>
<table border="0" cellspacing="4">
<tr>
    <td>
        <hr noshade size="1">
    </td>
</tr>
<tr>
<td align="left" valign="top">
<table>
    <tr>
        <td bgcolor="#525D76">
            <div align="right"><a href="index.html"><font size=-1 color="#ffffff"
                                                          face="arial,helvetica,sanserif">Index</font></a></div>
        </td>
        <td bgcolor="#525D76">
            <div align="right"><a href="listeners.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a>
            </div>
        </td>
        <td bgcolor="#525D76">
            <div align="right"><a href="build-jms-topic-test-plan.html"><font size=-1 color="#ffffff"
                                                                              face="arial,helvetica,sanserif">Prev</font></a>
            </div>
        </td>
    </tr>
</table>
<br>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="building"><strong>13. Building a Monitor Test Plan</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    In this section, you will learn how to create a

                    <a href="build-test-plan.html">
                        Test Plan
                    </a>
                    to monitor webservers. Monitors
                    are useful for a stress testing and system management. Used with stress
                    testing, the monitor provides additional information about server performance.
                    It also makes it easier to see the relationship between server performance
                    and response time on the client side. As a system administration tool, the
                    monitor provides an easy way to monitor multiple servers from one console.
                    The monitor was designed to work with the status servlet in Tomcat 5. In
                    theory, any servlet container that supports JMX (Java Management Extension)
                    can port the status servlet to provide the same information.
                </p>

                <p>
                    For those who want to use the monitor with other servlet or EJB containers,
                    Tomcat's status servlet should work with other containers for the memory
                    statistics without any modifications. To get thread information, you will
                    need to change the MBeanServer lookup to retrieve the correct MBeans.
                </p>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="adding_server"><strong>13.1 Adding A Server</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    The first step is to add a
                    <a href="test_plan.html#thread_group">
                        Thread Group
                    </a>

                    element. The Thread Group tells JMeter the number of threads you want. Always use
                    1, since we are using JMeter as a monitor. This is very important for those not
                    familiar with server monitors. As a general rule, using multiple threads for a
                    single server is bad and can create significant stress.

                </p>

                <p>
                    Go ahead and add the ThreadGroup element by first selecting the Test Plan,
                    clicking your right mouse button to get the Add menu, and then select
                    Add --> ThreadGroup.
                </p>

                <p>
                    You should now see the Thread Group element under Test Plan. If you do not
                    see the element, "expand" the Test Plan tree by clicking on the Test Plan element.
                </p>

                <p>
                <table border="0" cellspacing="0" cellpadding="0">
                    <tr>
                        <td><img width='$width' height='$height'
                                 src="../../docs/images/screenshots/webtest/threadgroup.png"><br>
                            <font size="-1">
                                Figure 13.1. Thread Group with Default Values
                            </font></td>
                    </tr>
                </table>
                </p>
                <p>
                    Change the loop count to forever (or some large number) so that enough samples are generated.
                </p>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="adding_auth"><strong>13.2 HTTP Auth Manager</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    Add the
                    <a href="../usermanual/component_reference.html#HTTP_Authorization_Manager">HTTP Authorization
                        Manager</a>
                    to the Thread Group element
                    (Add --> Config element --> HTTP Authorization Manager). Enter the username
                    and password for your webserver. Important note: the monitor only works with
                    Tomcat5 build 5.0.19 and newer. For instructions on how to setup Tomcat, please
                    refer to tomcat 5 documentation.
                </p>
                <ol>


                    <li>
                        leave the base URL blank
                    </li>


                    <li>
                        enter the username
                    </li>


                    <li>
                        enter the password
                    </li>


                </ol>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="adding_request"><strong>13.3 Adding HTTP Request</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    Add the
                    <a href="../usermanual/component_reference.html#HTTP_Request">HTTP Request</a>
                    to the Thread Group element
                    (Add --> Sampler --> HTTP Request). Then, select the HTTP Request element
                    in the tree and edit the following properties):

                <ol>


                    <li>
                        Change the Name field to "Server Status".
                    </li>


                    <li>
                        Enter the IP address or Hostname
                    </li>


                    <li>
                        Enter the port number
                    </li>


                    <li>
                        Set the Path field to "/manager/status" if you're using Tomcat.
                    </li>


                    <li>
                        Add a request parameter named "XML" in uppercase. Give it a value of
                        "true" in lowercase.
                    </li>


                    <li>
                        Check "Use as Monitor" at the bottom of the sampler
                    </li>


                </ol>


                </p>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="adding_timer"><strong>13.4 Adding Constant Timer</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    Add a timer to this thread group (Add --> Timer --> Constant Timer).
                    Enter 5000 milliseconds in the "Thread Delay" box. In general, using intervals shorter
                    than 5 seconds will add stress to your server. Find out what is an acceptable interval
                    before you deploy the monitor in your production environment.
                </p>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="adding_listener"><strong>13.5 Adding a Listener to Store the Results</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    If you want to save the raw results from the server, add a simple data

                    <a href="component_reference.html#listeners">
                        Listener
                    </a>
                    . If you want to save the
                    calculated statistics, enter a filename in the listener. If you want to save both
                    the raw data and statistics, make sure you use different filenames.
                </p>

                <p>
                    Select the thread group element and add a
                    <a href="../usermanual/component_reference.html#Simple_Data_Writer">Simple Data Writer</a>
                    listener
                    (Add --> Listener --> Simple Data Writer). Next, you need to specify a directory
                    and filename of the output file. You can either type it into the filename field, or
                    select the Browse button and browse to a directory and then enter a filename.
                </p>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<table border="0" cellspacing="0" cellpadding="2" width="100%">
    <tr>
        <td bgcolor="#525D76">
            <font color="#ffffff" face="arial,helvetica,sanserif">
                <a name="add_monitor_listener"><strong>13.6 Adding Monitor Results</strong></a></font>
        </td>
    </tr>
    <tr>
        <td>
            <blockquote>
                <p>
                    Add the
                    <a href="component_reference.html#listeners">
                        Listener
                    </a>
                    by selecting the
                    test plan element (Add --> Listener -- > Monitor Results).

                    <br>
                    </br>

                    By default, the Listener will select the results from the first connector in the sample response.
                    The Connector prefix field can be used to select a different connector.
                    If specified, the Listener will choose the first connector which matches the prefix.
                    If no match is found, then the first connector is selected.

                </p>

                <p>
                    There are two tabs in
                    the monitor results listener. The first is the "Health", which displays the status of
                    the last sample the monitor received. The second tab is "Performance", which shows a
                    historical view of the server's performance.

                </p>

                <p>
                <table border="0" cellspacing="0" cellpadding="0">
                    <tr>
                        <td><img width='$width' height='$height' src="../../docs/images/screenshots/monitor_health.png"><br>
                            <font size="-1"></font></td>
                    </tr>
                </table>
                </p>
                <p>
                    A quick note about how health is calculated. Typically, a server will crash if
                    it runs out of memory, or reached the maximum number of threads. In the case of
                    Tomcat 5, once the threads are maxed out, requests are placed in a queue until a
                    thread is available. The relative importance of threads vary between containers, so
                    the current implementation uses 50/50 to be conservative. A container that is more
                    efficient with thread management might not see any performance degradation, but
                    the used memory definitely will show an impact.
                </p>

                <p>
                <table border="0" cellspacing="0" cellpadding="0">
                    <tr>
                        <td><img width='$width' height='$height'
                                 src="../../docs/images/screenshots/monitor_screencap.png"><br>
                            <font size="-1"></font></td>
                    </tr>
                </table>
                </p>
                <p>
                    The performance graph shows for different lines. The free memory line shows how
                    much free memory is left in the current allocated block. Tomcat 5 returns the maximum
                    memory, but it is not graphed. In a well tuned environment, the server should never
                    reach the maximum memory.
                </p>

                <p>
                    Note the graph has captions on both sides of the graph. On the left is percent and
                    the right is dead/healthy. If the memory line spikes up and down rapidly, it could
                    indicate memory thrashing. In those situations, it is a good idea to profile the
                    application with Borland OptimizeIt or JProbe. What you want to see is a regular
                    pattern for load, memory and threads. Any erratic behavior usually indicates poor
                    performance or a bug of some sort.
                </p>
            </blockquote>
            </p>
        </td>
    </tr>
    <tr>
        <td><br></td>
    </tr>
</table>
<br>
<table>
    <tr>
        <td bgcolor="#525D76">
            <div align="right"><a href="index.html"><font size=-1 color="#ffffff"
                                                          face="arial,helvetica,sanserif">Index</font></a></div>
        </td>
        <td bgcolor="#525D76">
            <div align="right"><a href="listeners.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a>
            </div>
        </td>
        <td bgcolor="#525D76">
            <div align="right"><a href="build-jms-topic-test-plan.html"><font size=-1 color="#ffffff"
                                                                              face="arial,helvetica,sanserif">Prev</font></a>
            </div>
        </td>
    </tr>
</table>
</td>
</tr>
<tr>
    <td>
        <hr noshade size="1">
    </td>
</tr>
<tr>
    <td>
        <table width=100%>
            <tr>
                <td>
                    <font color="#525D76" size="-1"><em>
                        Copyright &copy; 1999-2009, Apache Software Foundation
                    </em></font>
                </td>
                <td align="right">
                    <font color="#525D76" size="-1"><em>
                        Updated: $Date: 2009-02-24 14:51:51 +0000 (Tue, 24 Feb 2009) $
                    </em></font>
                </td>
            </tr>
            <tr>
                <td colspan="2">
                    <div align="center"><font color="#525D76" size="-1">
                        "Apache", the Apache feather, and the Apache JMeter logo are
                        trademarks of the Apache Software Foundation for our open source software.
                    </font>
                    </div>
                </td>
            </tr>
        </table>
    </td>
</tr>
</table>
</body>
</html>






























